Skip to main content

Remapping attributes for 2.7 (Simpl Windows)

Driver 2.7.0 changed which attribute number carries which value.

Simpl Windows passes user attributes to the Crestron Device Drivers Security System Ethernet v2.0 module by position — the module hands attribute 1 to whatever the driver declares first, attribute 2 to the second, and so on. Nothing is matched by name. A program written for 2.5 or 2.6 therefore keeps compiling against 2.7 and sends every value to the wrong field, with no error and no warning.

This page is the remap. If you are building a new program from scratch, use the table on the Crestron Simpl page instead — you don't need this one.

What changed

Ajax now enforces two-factor authentication on every account, so the driver no longer takes a password: authentication moved to a one-time sign-in on the driver's Diagnostics page. Dropping Password, and moving the Licence Key to the front so it's the first thing an installer sets, is what shifts the numbering.

Attribute on CCD Wrapper2.5 / 2.62.7 and later
User Attribute 1Hub IDLicence Key
User Attribute 2Ajax Account EmailHub ID
User Attribute 3PasswordAjax Account Email
User Attribute 4Arming PINArming PIN
User Attribute 5Bypass PINBypass PIN
User Attribute 6SIA PortSIA Port
User Attribute 7Licence Keynot used

What to change in your program

Four rows move — the rest stay exactly where they are.

  1. User Attribute 1 — send the Licence Key (was the Hub ID).
  2. User Attribute 2 — send the Hub ID (was the account email).
  3. User Attribute 3 — send the Ajax account email (was the password). This is now optional and informational: it does not sign you in on its own, and you can leave it empty.
  4. User Attribute 7 — send nothing. There is no seventh attribute on 2.7. Clear the string and remove its trigger, or leave the string blank if that is easier — the driver ignores empty values.
Attributes 4, 5 and 6 do not move

Arming PIN, Bypass PIN and SIA Port keep their numbers. Removing Password shifts them down one place, and inserting the Licence Key at the front shifts them back up one, so they land where they started. Only the first three and the now-unused seventh need touching.

Rename your signals as well

The signal names in your program are yours — the module never sees them, so a signal still called USER_ATTRIBUTE_HUB_ID will happily carry the licence key into attribute 1. Rename them as you remap, or the program will read as correct while being wrong, and the next person to open it has no way to tell.

If you latch your attribute strings

If you persist the values — for example with a Make String Permanent symbol — check that symbol's rows separately. Its row numbers do not necessarily line up with the attribute numbers on the module (a comment or spare row is enough to offset them), so a correct-looking row 3 there may not be attribute 3.

Check it loaded correctly

Watch the processor console as the program starts. The driver prints one line per attribute as it is set, in the order the module sends them:

Set user attribute is called for value === > <value>

Read them in sequence: your licence key should appear first and the Hub ID second. That's the fastest way to confirm the remap without guessing.

If a required value never arrives, the driver refuses to connect and names what is missing:

[AJAX] - The following properties are not set: SiaPortSet, DevicePinSet, ArmingPinSet, HubIdSet
[AJAX] - AJAX DRIVER LOAD NOT COMPLETE
A misplaced licence key will not show up here

Only the Hub ID, both PINs and the SIA Port gate the connection. The Licence Key and the account email do not, so if you got attribute 1 wrong the driver still connects and then fails licensing later. Confirm the licence state on the Installation Report rather than assuming a connected driver is a correctly configured one.

After loading

Sign in to Ajax once from the driver's Diagnostics page — see Step two — sign in to Ajax. Until you do, the driver will report Not signed in and no cloud commands will work, however correct your attributes are.